Modul Interview Auswahl (REST)

Mit dem Modul Interview Auswahl (REST) (REpresentational State Transfer) kann eine Auswahlliste im WebClient oder am Gerätedisplay angezeigt werden, aus der der Anwender einen Eintrag wählen muss. Anhand der Auswahl des Anwenders können aus den per REST angeforderten Daten mehrere Variablen gefüllt werden, die im weiteren Verlauf des Workflows (z.B im Modul Entscheidung) oder auch in einer Metadatei verwendet werden können.

Im WebClient werden Interviews im Bereich Meine Aufgaben (siehe Meine Aufgaben) angezeigt. Um diesen Bereich sehen zu können, ist die Anwenderlizenz Dokumenten-Prüfung erforderlich.

Soll der Inhalt der Auswahltabelle ohne externe Quelle direkt im Modul eingegeben werden, verwenden Sie Modul Interview Auswahl.

Das Modul kann mehrfach im Workflow vorkommen.

Interviewmodule können seit Version 4.13 an beliebiger Stelle im Workflow aufgerufen werden.

Modul Start

Modul Interview Auswahl (REST)

Modul Entscheidung

Das Modul kann mit allen Modulen verbunden werden (es können sich dadurch unsinnige Workflows ergeben).

Keine einschränkenden Module.

Erfolgreich: Hier folgt das Modul, das nach erfolgreicher Eingabe bzw. Auswahl ausgeführt werden soll.

Abbrechen: Hier folgt das Modul, das ausgeführt werden soll, wenn der Anwender das Interview aktiv durch Druck auf die Abbrechen-Schaltfläche beendet hat.

Time-out: Hier folgt das Modul, das ausgeführt werden soll, wenn nach dem in den Moduleinstellungen festgelegten Time-out-Zeitraum die Eingabe nicht abgeschlossen ist.

Die Einstellungen hängen sehr stark von der Art der REST-Schnittstelle ab. Besonders die Verbindungseinstellungen sind sehr individuell.

Geben Sie hier den Text an, der über der Auswahlliste angezeigt werden soll (z.B. Wählen Sie einen Dokumententyp.)

Hier können Sie einen Zeitraum in Minuten festlegen, nach dem das Modul mit dem Ausgang Time-out fortgesetzt wird, wenn der Anwender im Interview keine Eingabe vornimmt. Die Zeit läuft unabhängig von Tastatureingaben, sie gilt als abgeschlossen, wenn die Schaltfläche Fortsetzen am Gerät gedrückt wird (d.h. der Anwender muss in dieser Zeit die Eingabe vollständig abgeschlossen haben).

Der Wert 0 steht für kein Time-out (die Zeit für die Eingabe am Gerät ist unbegrenzt).

Im WebClient werden Interviews im Bereich Meine Aufgaben (siehe Meine Aufgaben) angezeigt. Um diesen Bereich sehen zu können, ist die Anwenderlizenz Dokumenten-Prüfung erforderlich.

Das Interview wird am Gerät angezeigt und kann dort beantwortet werden.

Mit den Verbindungseinstellungen wird die Verbindung zur externen API (Schnittstelle, Application Programming Interface) hergestellt. Diese sind stark von der API abhängig. Grundsätzlich wird die REST-Schnittstelle mit den Verbindungsdaten abgefragt und es kommt ein JToken zurück (als Objekt oder Array).

  • Verbindung: Wählen Sie aus der Klappliste die gewünschte Verbindung aus. Ist noch keine Verbindung vorhanden, klicken Sie auf Verbindung erstellen, siehe auch API Verbindungen.

  • Ressource: Eine Ressource kann jedes Objekt sein, über das die API Informationen bereitstellt oder entgegennimmt, z.B. restinformation/user. (Kein / am Anfang der Ressource setzen.) Die Ressource wird bei der Abfrage an die Basis URL, die bei der Verbindung angegeben wird, angehangen.

Mit Verbindung prüfen können Sie die Verbindungsdaten testen. Es wird das JSON-Objekt der Schnittstelle zurückgeliefert.

Der Filter filtert das Rückgabeergebnis der Verbindung. So kann die Darstellung für das Interview verfeinert werden. Es werden dazu Felder aus dem JSON-Objekt, das die REST-Schnittstelle geliefert hat, extrahiert, so dass dem Anwender eine einfache, gut lesbare Liste präsentiert wird. Es wird beim Filter der JSON-Path-Syntax zugrunde gelegt (siehe https://docs.oracle.com/cd/E60058_01/PDF/8.0.8.x/8.0.8.0.0/PMF_HTML/JsonPath_Expressions.htm).

Mit Filter prüfen wird der Filter angewendet und eine Liste zeigt, welche Inhalte dem Anwender angezeigt werden.

Die Ausgabe für das Interview verwendet das Objekt, das durch den Filter definiert wurde. Aus diesem Objekt sollten für den Anwender ein leicht zu lesende Listeneinträge extrahiert werden. Die anzuzeigenden Felder und auch beliebige Trennzeichen können im Feld Datenmaske definiert werden, z.B.:

  • {{Name}}

  • {{displayName}} - {{officeLocation}}

Es können aus den Daten mehrere Variablen in einem Zug gefüllt werden. Fügen Sie Variablen über Variable hinzufügen hinzu oder entfernen Sie Variablen mit dem Löschsymbol .

  • Variablenname: Name der Variable, z.B. Name.

  • Datenmaske: Geben Sie hier die Datenmaske ein, die den gewünschten Wert aus dem Filterergebnis ausgibt, z.B. {{displayName}}.

Variablennamen dürfen keine Sonderzeichen enthalten. Erlaubt sind kleine und große Buchstaben (keine Umlaute o.Ä.), Zahlen und der Punkt ".".
Wird der Variablenname an mehreren Stellen verwendet, können alle Stellen den Variablenwert beeinflussen.

In diesem Modul können bei verschiedenen Einstellungen Variablen verwendet werden. (z.B. folder/%customer_folder%). Um die Funktion bei der Entwicklung des Workflows testen zu können, können an dieser Stelle Testwerte für die verwendeten Variablen eingegeben werden. Bei einigen Einstellungen sind Prüffunktionen vorhanden (z.B. Verbindung prüfen oder Filter prüfen). Bei diesen Funktionen werden dann die in diesem Bereich der Variable zugewiesenen Werte eingesetzt.

Mit Variable hinzufügen legen Sie eine neue Zeile an.

  • Variablenname: Variablenname einer Variable, die im Modul für eine Abfrage verwendet wird (z.B. customer_folder).

  • Wert: Geben Sie den Wert der Variable ein, der in Prüffunktionen in diesem Modul verwendet werden soll (z.B. Invoices).

Der WorkflowService kennt alle Informationen rund um einen (im Workflow-Editior erstellten) Workflow. Er sorgt dafür, dass der Ablauf eingehalten wird und leitet Informationen an im Workflow folgende Module bzw. deren Dienste weiter. Seine Logdatei ist Logs\WorkflowService.log.